/*******************************************************************************
* Copyright (c) 2012, Project: FP7-ICT-257930 Aniketos
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* - Neither the name of institution nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
******************************************************************************/
/*
* Page1.java
*
* This file is part of the STS-Tool project.
* Copyright (c) 2011-2012 "University of Trento - DISI" All rights reserved.
*
* Is strictly forbidden to remove this copyright notice from this source code.
*
* Disclaimer of Warranty:
* STS-Tool (this software) is provided "as-is" and without warranty of any kind,
* express, implied or otherwise, including without limitation, any warranty of
* merchantability or fitness for a particular purpose.
* In no event shall the copyright holder or contributors be liable for any direct,
* indirect, incidental, special, exemplary, or consequential damages
* including, but not limited to, procurement of substitute goods or services;
* loss of use, data, or profits; or business interruption) however caused and on
* any theory of liability, whether in contract, strict liability, or tort (including
* negligence or otherwise) arising in any way out of the use of this software, even
* if advised of the possibility of such damage.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License version 3
* as published by the Free Software Foundation with the addition of the
* following permission added to Section 15 as permitted in Section 7(a):
* FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
* "University of Trento - DISI","University of Trento - DISI" DISCLAIMS THE
* WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* See the GNU Affero General Public License for more details.
* You should have received a copy of the GNU Affero General Public License
* along with this program; if not, see http://www.gnu.org/licenses or write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA, 02110-1301 USA, or download the license from the following URL:
* http://www.sts-tool.eu/License.php
*
* For more information, please contact STS-Tool group at this
* address: ststool@disi.unitn.it
*
*/
package eu.aniketos.wp1.ststool.threats.wizard;
import java.lang.reflect.InvocationTargetException;
import java.net.ConnectException;
import java.net.MalformedURLException;
import java.net.URL;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.wizard.WizardPage;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.ScrolledComposite;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.events.FocusListener;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.KeyListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.FontData;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.layout.FormAttachment;
import org.eclipse.swt.layout.FormData;
import org.eclipse.swt.layout.FormLayout;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Link;
import org.eclipse.swt.widgets.List;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.PlatformUI;
import eu.aniketos.threatrepository.schema.download.Threat;
import eu.aniketos.threatrepository.schema.download.Threat.Metadata;
import eu.aniketos.threatrepository.schema.download.Threat.Metadata.Externalrefs;
import eu.aniketos.wp1.ststool.threats.ThreatRepositoryUIEventProcessor;
public class LookupThreatsPage extends WizardPage implements IRunnableWithProgress {
private boolean isSearchPerformed;
private ArrayList<Threat> threatsFromRepository;
private Threat selectedThreat;
private String searchFilter;
private Composite container;
private Composite threatsListContainer;
private Text searchInput;
private Button searchButton;
private List threatsList;
private Composite groupContainer;
private Group detailsGroup;
private KeyListener keyListener;
/**
* Create the wizard.
*/
public LookupThreatsPage() {
super("wizardPage");
setTitle("Search for threat definitions");
setDescription("Browse threats from the Aniketos Threat Repository");
isSearchPerformed = false;
threatsFromRepository = new ArrayList<Threat>();
selectedThreat = null;
searchFilter = "";
}
public LookupThreatsPage(String searchString, ArrayList<Threat> searchResults, Threat selectedThreat) {
super("wizardPage");
setTitle("Search for threat definitions");
setDescription("Browse threats from the Aniketos Threat Repository");
isSearchPerformed = false;
restoreFinishedState(searchString, searchResults, selectedThreat);
}
private void restoreFinishedState(String searchString, ArrayList<Threat> searchResults, Threat selectedThreat) {
searchFilter = searchString;
threatsFromRepository = searchResults;
this.selectedThreat = selectedThreat;
// updateThreatSelectionList();
// buildDetailsGroup();
}
/**
* Create contents of the wizard.
*
* @param parent
*/
public void createControl(Composite parent){
container = new Composite(parent, SWT.NULL);
setControl(container);
GridLayout gridLayout = new GridLayout();
gridLayout.verticalSpacing = 15;
gridLayout.numColumns = 1;
container.setLayout(gridLayout);
GridData horizontalFillLayout = new GridData();
horizontalFillLayout.horizontalAlignment = SWT.FILL;
horizontalFillLayout.grabExcessHorizontalSpace = true;
Composite searchFormContainer = new Composite(container, SWT.NONE);
searchFormContainer.setLayout(new FormLayout());
searchFormContainer.setLayoutData(horizontalFillLayout);
Label searchLabel = new Label(searchFormContainer, SWT.NONE);
FormData searchLabelLayout = new FormData();
searchLabelLayout.right = new FormAttachment(100, 0);
searchLabelLayout.left = new FormAttachment(0, 6);
searchLabel.setLayoutData(searchLabelLayout);
searchLabel.setText("Browse threat definitions:");
searchInput = new Text(searchFormContainer, SWT.BORDER);
FormData searchInputLayout = new FormData();
searchInputLayout.right = new FormAttachment(80, 0);
searchInputLayout.top = new FormAttachment(searchLabel, 6);
searchInputLayout.left = new FormAttachment(0, 6);
searchInput.setLayoutData(searchInputLayout);
searchInput.setMessage("Type filter for threats here (optional)");
if (searchFilter != null && searchFilter != "")
searchInput.setText(searchFilter);
keyListener = new KeyListener() {
@Override
public void keyReleased(KeyEvent e) {
if (e.keyCode == SWT.CR || e.keyCode == SWT.KEYPAD_CR) {
searchButtonFired();
e.doit = false;
}
}
@Override
public void keyPressed(KeyEvent e) { }
};
searchInput.addFocusListener(new FocusListener() {
@Override
public void focusLost(FocusEvent e) {
if (threatsList.getSelectionCount() > 0)
setPageComplete(true);
searchInput.removeKeyListener(keyListener);
}
@Override
public void focusGained(FocusEvent e) {
setPageComplete(false);
searchInput.addKeyListener(keyListener);
}
});
searchButton = new Button(searchFormContainer, SWT.PUSH);
FormData searchButtonLayout = new FormData();
searchButtonLayout.right = new FormAttachment(100, -6);
searchButtonLayout.top = new FormAttachment(searchLabel, 4);
searchButtonLayout.left = new FormAttachment(searchInput, 6);
searchButton.setLayoutData(searchButtonLayout);
searchButton.setText("Search");
searchButton.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
searchButtonFired();
threatsListSelectionChanged();
}
});
threatsListContainer = new Composite(container, SWT.NULL);
GridData threatsListContainerLayout = new GridData();
threatsListContainerLayout.horizontalAlignment = SWT.FILL;
threatsListContainerLayout.grabExcessHorizontalSpace = true;
threatsListContainerLayout.verticalAlignment = SWT.FILL;
threatsListContainerLayout.grabExcessVerticalSpace = true;
threatsListContainerLayout.minimumHeight = 200;
threatsListContainerLayout.heightHint = 200;
threatsListContainer.setLayoutData(threatsListContainerLayout);
GridLayout threatListContainerGridLayout = new GridLayout();
threatListContainerGridLayout.verticalSpacing = 6;
threatListContainerGridLayout.numColumns = 1;
threatsListContainer.setLayout(threatListContainerGridLayout);
Label listLabel = new Label(threatsListContainer, SWT.NONE);
listLabel.setText("Select a threat from the list below:");
threatsList = new List(threatsListContainer, SWT.BORDER | SWT.V_SCROLL | SWT.SINGLE);
GridData threatsListLayout = new GridData();
threatsListLayout.grabExcessHorizontalSpace = true;
threatsListLayout.horizontalAlignment = SWT.FILL;
threatsListLayout.grabExcessVerticalSpace = true;
threatsListLayout.verticalAlignment = SWT.FILL;
threatsListLayout.minimumHeight = 100;
threatsListLayout.heightHint = 200;
threatsList.setLayoutData(threatsListLayout);
threatsList.addListener(SWT.Selection, new Listener() {
public void handleEvent (Event e) {
threatsListSelectionChanged();
}
});
updateThreatSelectionList();
// threatsList.addListener (SWT.DefaultSelection, new Listener() {
// public void handleEvent (Event e) { }
// });
groupContainer = new Composite(container, SWT.NONE);
GridData groupContainerLayout = new GridData();
groupContainerLayout.minimumHeight = 90;
groupContainerLayout.horizontalAlignment = SWT.FILL;
groupContainerLayout.grabExcessHorizontalSpace = true;
groupContainerLayout.verticalAlignment = SWT.FILL;
groupContainerLayout.grabExcessVerticalSpace = true;
groupContainerLayout.heightHint = 250;
groupContainer.setLayoutData(groupContainerLayout);
GridLayout groupContainerGridLayout = new GridLayout(1, false);
groupContainerGridLayout.verticalSpacing = 6;
groupContainer.setLayout(groupContainerGridLayout);
buildDetailsGroup();
Control[] tabOrder = new Control[] { searchInput, searchButton }; // searchLabel,
searchFormContainer.setTabList(tabOrder);
container.forceFocus();
container.getShell().setDefaultButton(searchButton);
parent.getShell().setDefaultButton(searchButton);
parent.setSize(container.computeSize(SWT.DEFAULT, SWT.DEFAULT));
}
protected void searchButtonFired() {
searchFilter = getSearchText();
selectedThreat = null;
triggerThreatsDownload();
isSearchPerformed = true;
updateThreatSelectionList();
buildDetailsGroup();
}
protected void threatsListSelectionChanged() {
setErrorMessage(null);
if (threatsList.getSelectionCount() > 0) {
int selection = threatsList.getSelectionIndex();
selectedThreat = (Threat) threatsList.getData(selection + "");
boolean isPageComplete = (selectedThreat != null);
setPageComplete(isPageComplete);
}
else {
selectedThreat = null;
setPageComplete(false);
}
buildDetailsGroup();
}
private void buildDetailsGroup() {
if (detailsGroup != null)
detailsGroup.dispose();
detailsGroup = new Group(groupContainer, SWT.NONE);
GridData detailsGroupLayout = new GridData();
detailsGroupLayout.horizontalAlignment = SWT.FILL;
detailsGroupLayout.grabExcessVerticalSpace = true;
detailsGroupLayout.verticalAlignment = SWT.FILL;
detailsGroupLayout.minimumHeight = 90;
detailsGroupLayout.heightHint = 250;
detailsGroup.setLayoutData(detailsGroupLayout);
detailsGroup.setText("Detailed information");
detailsGroup.setLayout(new FillLayout());
ScrolledComposite groupScrollContainer = new ScrolledComposite(detailsGroup, SWT.V_SCROLL);
groupScrollContainer.setExpandHorizontal(true);
groupScrollContainer.setExpandVertical(true);
Composite detailsContainer = new Composite(groupScrollContainer, SWT.NONE);
GridLayout gridLayout = new GridLayout();
gridLayout.numColumns = 2;
gridLayout.horizontalSpacing = 10;
gridLayout.verticalSpacing = 10;
detailsContainer.setLayout(gridLayout);
if (selectedThreat != null) {
setPageComplete(true);
Metadata threatData = selectedThreat.getMetadata();
Label nameLabel = new Label(detailsContainer, SWT.NONE);
FontData[] fD = nameLabel.getFont().getFontData();
fD[0].setStyle(SWT.BOLD);
Font font = new Font(container.getDisplay(), fD[0]);
nameLabel.setText("Threat");
nameLabel.setFont(font);
Label nameText = new Label(detailsContainer, SWT.NONE);
nameText.setText(threatData.getName());
nameText.setSize(445, nameLabel.getSize().y);
// Label typeLabel = new Label(detailsContainer, SWT.NONE);
// typeLabel.setText("Type/class");
// typeLabel.setFont(font);
// Label typeText = new Label(detailsContainer, SWT.NONE);
// typeText.setText(threatData.getType() + " (" + threatData.getThreatclass() + ")");
Label descLabel = new Label(detailsContainer, SWT.NONE);
descLabel.setText("Description");
descLabel.setFont(font);
GridData descLabelLayout = new GridData();
descLabelLayout.verticalAlignment = SWT.BEGINNING;
descLabel.setLayoutData(descLabelLayout);
final StyledText descTextbox = new StyledText(detailsContainer, SWT.WRAP | SWT.MULTI | SWT.READ_ONLY);
descTextbox.setText(threatData.getDescription());
descTextbox.setCursor(Display.getCurrent().getSystemCursor(SWT.CURSOR_ARROW));
descTextbox.setCaret(null);
descTextbox.setBackground(Display.getCurrent().getSystemColor(SWT.COLOR_WIDGET_BACKGROUND));
GridData descTextboxLayout = new GridData();
descTextboxLayout.grabExcessVerticalSpace = false;
descTextboxLayout.verticalAlignment = SWT.FILL;
descTextboxLayout.horizontalAlignment = SWT.BEGINNING;
descTextboxLayout.widthHint = 445;
descTextbox.setLayoutData(descTextboxLayout);
descTextbox.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
descTextbox.setSelection(0);
}
});
// Composite externalrefsContainer = new Composite(detailsContainer, SWT.NONE);
// externalrefsContainer.setLayout(new GridLayout(2, false));
Externalrefs externalrefs = threatData.getExternalrefs();
if (externalrefs != null && externalrefs.getExternalref().size() > 0) {
Label externalrefsLabel = new Label(detailsContainer, SWT.NONE);
externalrefsLabel.setText("Resources");
externalrefsLabel.setFont(font);
externalrefsLabel.setAlignment(SWT.LEAD);
Composite externalrefsContainer = new Composite(detailsContainer, SWT.NONE);
externalrefsContainer.setLayout(new GridLayout(1, false));
for (String ref : externalrefs.getExternalref()) {
Link link = new Link(externalrefsContainer, SWT.NONE);
String urlText = ref.length() > 70 ? ref.substring(0, Math.min(ref.length(), 70)) + "..." : ref;
link.setText("<A href=\"" + ref + "\">" + urlText + "</A>");
link.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
try {
// Open default external browser
PlatformUI.getWorkbench().getBrowserSupport().getExternalBrowser().openURL(new URL(e.text));
} catch (PartInitException ex) {
// TODO Auto-generated catch block
ex.printStackTrace();
} catch (MalformedURLException ex) {
// TODO Auto-generated catch block
ex.printStackTrace();
}
}
});
}
}
Label uuidLabel = new Label(detailsContainer, SWT.NONE);
uuidLabel.setText("ID");
uuidLabel.setFont(font);
Label uuidText = new Label(detailsContainer, SWT.NONE);
uuidText.setText(threatData.getThreatId());
SimpleDateFormat df = new SimpleDateFormat();
df.applyPattern("dd/MM/yyyy");
Date createdDate = threatData.getCreationdate().toGregorianCalendar().getTime();
Date updatedDate = threatData.getLastupdated().toGregorianCalendar().getTime();
Label createdLabel = new Label(detailsContainer, SWT.NONE);
createdLabel.setText("Created");
createdLabel.setFont(font);
Label createdText = new Label(detailsContainer, SWT.NONE);
String dateText = df.format(createdDate);
if (!createdDate.equals(updatedDate))
dateText += " - updated " + df.format(updatedDate);
createdText.setText(dateText);
}
else
setPageComplete(false);
detailsContainer.setSize(detailsContainer.computeSize(530, SWT.DEFAULT));
groupScrollContainer.setContent(detailsContainer);
groupScrollContainer.setMinSize(detailsContainer.getSize());
groupContainer.layout();
}
public String getSearchText() {
String filter = searchInput.getText();
if (filter == "")
filter = null;
return filter;
}
public ArrayList<Threat> getThreatsList() {
return threatsFromRepository;
}
public void setThreatsList(ArrayList<Threat> threats) {
this.threatsFromRepository = threats;
}
public void updateThreatSelectionList() {
int index = 0;
threatsList.removeAll();
if (!threatsFromRepository.isEmpty()) {
setErrorMessage(null);
for (Threat threat : threatsFromRepository) {
Metadata data = threat.getMetadata();
threatsList.add(data.getName(), index); // + ": " + data.getDescription()
threatsList.setData(index + "", threat);
if (selectedThreat != null && selectedThreat.getMetadata().getThreatId().equals(threat.getMetadata().getThreatId())) {
threatsList.setSelection(index);
selectedThreat = threat;
}
index++;
}
}
else if (isSearchPerformed && getErrorMessage() == null)
setErrorMessage("No matching threat definitions were found!");
}
public Threat getSelectedThreat() {
return selectedThreat;
}
@Override
public void setErrorMessage(String newMessage){
super.setErrorMessage(newMessage);
if (newMessage == null && !isPageComplete())
setPageComplete(true);
else if (newMessage != null && isPageComplete())
setPageComplete(false);
}
public void triggerThreatsDownload() {
final IRunnableWithProgress runnable = this;
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
try {
getContainer().run(true, true, runnable);
} catch (InvocationTargetException e) {
MessageDialog.openError(container.getShell(), "Threat Repository lookup failed", e.getMessage());
e.printStackTrace();
} catch (InterruptedException e) {
// MessageDialog.openInformation(container.getShell(), "Cancelled", "The operation was canceled.");
dispose();
e.printStackTrace();
} catch (Exception e) {
MessageDialog.openError(container.getShell(), "Unknown error", e.getMessage());
e.printStackTrace();
}
}
});
}
@Override
public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
monitor.beginTask("Performing search. Please wait...", IProgressMonitor.UNKNOWN);
try {
ThreatRepositoryServiceWrapper processor = new ThreatRepositoryServiceWrapper();
// ThreatRepositoryUIEventProcessor processor = new ThreatRepositoryUIEventProcessor();
// ArrayList<Threat> threatsFromRepository = processor.processSearchThreatEvent(searchFilter);
ArrayList<Threat> threatsFromRepository = processor.processGetThreatsEvent(searchFilter);
setThreatsList(threatsFromRepository);
} catch (ConnectException e) {
e.printStackTrace();
throw new InvocationTargetException(e, "Connection error: " + e.getMessage());
} catch (Exception e) {
e.printStackTrace();
throw new InvocationTargetException(e, "Internal error: " + e.getMessage());
}
monitor.done();
}
}